<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IAdjustmentGroup</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IAdjustmentGroup</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A type that represents a selection of <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a>s, which are logically OR'ed.</p>
<p class="description"><p>Each adjustment group is in turn AND'ed with the other adjustment groups of an  <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a> instance.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IAdjustmentGroup.html 20 2010-01-28 14:33:07Z kenn.north $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---navigation---IAdjustmentGroup.php.html">/src/sde/fastsearch/navigation/IAdjustmentGroup.php</a> (line <span class="field">32</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>
										<a href="#add" title="details" class="method-name">add</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$modifier</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$modifyMode</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#clear" title="details" class="method-name">clear</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>
										<a href="#get" title="details" class="method-name">get</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$modifierName</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getFilterTerm" title="details" class="method-name">getFilterTerm</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getIndex" title="details" class="method-name">getIndex</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a></span>
										<a href="#getNavigation" title="details" class="method-name">getNavigation</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
										<a href="#getNavigator" title="details" class="method-name">getNavigator</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getNavigatorAttribute" title="details" class="method-name">getNavigatorAttribute</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getNavigatorName" title="details" class="method-name">getNavigatorName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isEmpty" title="details" class="method-name">isEmpty</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#iterator" title="details" class="method-name">iterator</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#remove" title="details" class="method-name">remove</a>
											(<span class="var-type"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>&nbsp;<span class="var-name">$adjustment</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeByName" title="details" class="method-name">removeByName</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$modifierName</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#size" title="details" class="method-name">size</a>
										()
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodadd" id="add"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">add</span> (line <span class="line-number">40</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds an <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a> to this group.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>
		<span class="method-name">
			add
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$modifier</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$modifyMode</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
				<span class="var-name">$modifier</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$modifyMode</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclear" id="clear"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">clear</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears this adjustment group.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			clear
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get</span> (line <span class="line-number">59</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a> associated to the named <a href="../sde_fastsearch_result/IModifier.html">IModifier</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>
		<span class="method-name">
			get
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$modifierName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$modifierName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetFilterTerm" id="getFilterTerm"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getFilterTerm</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retruns the filterterm produced by this adjustment group alone.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFilterTerm
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetIndex" id="getIndex"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getIndex</span> (line <span class="line-number">67</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns current index of this adjustment group in contaning <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a>,  grouped by <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getIndex
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetNavigation" id="getNavigation"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getNavigation</span> (line <span class="line-number">74</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns containing <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a></span>
		<span class="method-name">
			getNavigation
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetNavigator" id="getNavigator"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getNavigator</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the associated <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
		<span class="method-name">
			getNavigator
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetNavigatorAttribute" id="getNavigatorAttribute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getNavigatorAttribute</span> (line <span class="line-number">87</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the associated navigator attribute.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getNavigatorAttribute
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetNavigatorName" id="getNavigatorName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getNavigatorName</span> (line <span class="line-number">93</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the associated navigator name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getNavigatorName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisEmpty" id="isEmpty"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isEmpty</span> (line <span class="line-number">99</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if there are no <a href="../sde_fastsearch_result/IModifier.html">IModifier</a>s.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isEmpty
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoditerator" id="iterator"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">iterator</span> (line <span class="line-number">105</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Iterates over the <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a>s in this group.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			iterator
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodremove" id="remove"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">remove</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the given <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			remove
		</span>
					(<span class="var-type"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>&nbsp;<span class="var-name">$adjustment</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a></span>
				<span class="var-name">$adjustment</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveByName" id="removeByName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeByName</span> (line <span class="line-number">115</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the <a href="../sde_fastsearch_navigation/IAdjustment.html">IAdjustment</a> associated to the named <a href="../sde_fastsearch_result/IModifier.html">IModifier</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeByName
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$modifierName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$modifierName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsize" id="size"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">size</span> (line <span class="line-number">121</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the count of <a href="../sde_fastsearch_result/IModifier.html">IModifier</a>s.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			size
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:36:04 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>